home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / DISK / FARPLUS.ARJ / FARPLUS.DOC < prev    next >
Text File  |  1992-01-09  |  16KB  |  308 lines
  1.  
  2.   ------   --------     ------ FULLY WORKING DEMO -------    --------   ------
  3.  
  4.          FAR+ - FAR directory enhancement program        v0192-DEMO
  5.              ----------------------------------------------------
  6.             For TBBS 2.2 sysops using TDBS v1.1.x  or GamePak TDBS
  7.  
  8.               Copyright (C) 1991, James E. Toro BBS Concepts
  9.  
  10.  
  11.             !!!!  - This demo will expire on 03/01/92 -   !!!!
  12.  
  13.  
  14.     --->>> Support bbs - 516-938-6722  - Leave message to the SYSOP    <<<---
  15.                    vox - 516-938-1729
  16.                    fax - 516-938-0675
  17.  
  18.  
  19.         >   The fully-functional and enhanced version of FARPLUS is    <
  20.         >   available for $15. See the file FPORDER.TXT for more info. <
  21.  
  22.  
  23.   Overview:
  24.  
  25.       If you are a seasoned TBBS sysop you are probably aware of the
  26.       .FAR file area option which links many TBBS Pseudo-Directories
  27.       into one group of areas.  While this feature is very useful for
  28.       regular users or sysops it can cause some confusion for new
  29.       users.  Also, the FAR system has a "feature" which allows a
  30.       user to execute certain commands and have them take effect
  31.       on ALL the pseudo directories that are in the .FAR area. Commands
  32.       like <N>ew or <L>ist can allow a user to search ALL directories
  33.       even if the user did not want to do so.  Most sysops who have
  34.       a "Uploads Library" generally have ONE area which gets the
  35.       daily or new uploads and then several dozen or more areas which
  36.       have categorized files, like utilties or communication programs.
  37.       The .FAR commands <N>ew or <L>ist will allow a user to search
  38.       ALL your areas for new files, even if they would only be in
  39.       one particular area. If you run a bbs with a big file area you
  40.       know how annoying it can be to watch a user go to your "recent
  41.       uploads" area and type a command like <N>ew, only to list ALL
  42.       50 or 60 areas of the .FAR group.  Also many new users may
  43.       go to a specific file area and do a <L>ist with a string after
  44.       it and not only get the requested search for that single area, but
  45.       also all other areas in the .FAR.  Another annoyance is to see
  46.       a user select an area and do a list of the files, if they get the
  47.       download prompt back and accidentaly hit RETURN then they get
  48.       kicked out of the .FAR and go back to the calling menu.  I have
  49.       spent countless hours watching new users do the above commands
  50.       and make many mistakes using the .FARs and that has lead me to
  51.       come up with an TBBS .FAR enhancement utility.
  52.  
  53.  Release note:
  54.  
  55.       This version contains:
  56.  
  57.       1) Ability to create a .FAR database directly from your unaltered
  58.          TBBS ".FAR" file. An external program will read the .FAR and
  59.          build the .FAR database and then create a TEXT file of the
  60.          new .FAR database for your perusal. This text file can help
  61.          you to quickly see if the build of the .FAR database went well
  62.          and is a good hard-copy offline reference for what your
  63.          .FAR areas numbers, paths and descriptions are.
  64.  
  65.       2) This  program does NOT require ANSI or color. Only BRIGHT WHITE
  66.          text and clear screens are used. No direct cursor placement is
  67.          done.
  68.  
  69.       3) This program will allow users to see ALL .DIRS in your .FAR as
  70.          though they were an actual .FAR BUT all the dirs are treated
  71.          as seperate like a TYPE=46 menu option.  This enables users
  72.          to perform any of the standard "download prompt" functions
  73.          but ONLY to the specific file area of the .FAR they are in.
  74.  
  75.       4) This program keeps the user in the requested .DIR of the .FAR
  76.          until they decide to change areas or quit out of the menu option.
  77.          What this means is that they can accidentaly hit return and not
  78.          get bounced back to the calling CTL menu. Rather they go to
  79.          a option line to either switch areas OR quit the .FAR option.
  80.          Every time they hit return at the download prompt without entering
  81.          a command or option the program will jump to the menu which allows
  82.          them to change areas or back to the down prompt/command line.
  83.          Repeated hitting of return toggles them between these two
  84.          different option lines. See "Running info" for details.
  85.  
  86.       5) FAST OPERATION. Don't be fooled that because this is a TDBS
  87.          application that it is slowed by TDBS.  This program uses
  88.          the DOTBBS function for ALL actual file directory handling
  89.          so the users do not experiance the normal TDBS processing
  90.          overhead.  You can have DOZENS of users running this function
  91.          at the same time and nobody will sense a slow down other than
  92.          normal system loading.
  93.  
  94.       6) Seamless operation.  This program does not have any startup
  95.          screens or copyrights. This function actually looks like an
  96.          enhanced version of the TBBS type=4 .FAR function.
  97.  
  98.  Installation:
  99.  
  100.      For the information below it is important to understand that a
  101.      TBBS ".FAR" is normally handled with a TYPE=4 menu option that
  102.      calls a .FAR file.  This program will create a .FAR DATABASE
  103.      that mimics the TYPE=4 but actually uses the TYPE=46  Pseudo
  104.      directory download menu options. Any reference to Opt Data
  105.      settings for TYPE=46 are made because that is the actual function
  106.      that is used for the file handling of the file directories of
  107.      this .FAR simulation program. I hope that makes sense.
  108.  
  109.  
  110.      Unzip the zip file and you will find three files:
  111.  
  112.            FARPLUS.TPG   -  The TPG program for FAR+
  113.            FARBUILD.EXE  -  The .FAR database builder
  114.            FARPLUS.DOC   -  This DOC you are reading.
  115.            FARPLUS.DBF   -  The FAR+ database
  116.            FPORDER.TXT   -  Registration form (Please feed the author!)
  117.  
  118.      Create a special sub-dir for these files ON YOUR HARD DRIVE.
  119.  
  120.       After you unzipped the file that was holding this info file,
  121.       you ended up with several files and  1 TPG. Copy all of them
  122.       to the new sub-dir you created for this program.
  123.  
  124.       NOW, copy the .FAR directory that you want to use INTO THE NEW
  125.       SPECIAL DIRECTORY YOU ARE USING FOR THIS PROGRAM. The .FAR will
  126.       NOT be modified by this program NOR do you need to modify it from
  127.       any existing formats for use here. The .FAR must follow the
  128.       standard .FAR format. Each directory to be handled in the
  129.       .FAR must have its path, directory name and extension in this
  130.       .FAR.  If your .FAR works with TBBS, it should work here, with
  131.       no editing.
  132.  
  133.       Run the FARBUILD.EXE program and watch what it reports. It will
  134.       ALWAYS start by clearing out the existing FAR+ database and then
  135.       will import the .FAR file into the database in the new special
  136.       fields format. If the import goes okay then the program will
  137.       create a OUTPUT TEXT LISTING called FARPLUS.TXT.  This text file
  138.       is for reference only.  Quickly review it to see if ALL areas
  139.       imported correctly and if the files paths AND descriptions line
  140.       up in the listing. If all went well then you are done building
  141.       the .FAR database.  You can run this as often as needed just by
  142.       copying the .FAR file you want to work with into this sub-dir and
  143.       re-running the FARBUILD program.
  144.  
  145.       NOTE!:  TBBS allows you to use a special optional ACCESS authorization
  146.               flag parameter for each area in your .FAR if you choose
  147.               to. That would give you the ability to limit users to
  148.               areas only matching certain A-Flags in their userlog record.
  149.               This program will NOT use the OPTIONAL ACCESS data in a
  150.               .FAR if it is found.  You do not have to remove it from the
  151.               .FAR, but be aware that any line containing the
  152.               'An=X--.----' type data will be treated like any normal
  153.               line in your .FAR.  This special parameter is rarely used
  154.               so I decided to leave it out of this program.
  155.  
  156.  
  157.       Next create a TYPE 200 menu option. It should contain OPT DATA
  158.       with the following:
  159.  
  160.          OPT DATA = C:\FARPLUS\FARPLUS /Q
  161.  
  162.        (Here we assume "C:\FARPLUS" is the sub-dir. The program to call  )
  163.        (is FARPLUS.Use the "/Q" option to remove the TDBS loading screen.)
  164.        (If you don't use the "/Q" users will be able to tell this is a   )
  165.        ("door" and not an internal function!!.                           )
  166.  
  167.       This free version does not limit anyone from using the program, so
  168.       you will have to create a menu with a privilege level high enough
  169.       to keep out unwanted users. ALSO since this program acts like a
  170.       group of linked TYPE=46 menu options, this demo will not allow
  171.       you to change the OPT DATA for the TYPE=46.  The default
  172.       options for this demo are:
  173.  
  174.                       /F  /TL  /X:ZIP  /NL  /NAD
  175.  
  176.       (Date precedes file desc, pre-check transfer time against limits)
  177.       (default extension is ZIP if non specified by user, DO NOT list )
  178.       (files automatically, do not use alternate directory format     )
  179.       (      ALL other non-specified options are TYPE=46 defaults     )
  180.  
  181. -->   The $15 REGISTERED version allows you to create ANY kind of LEGAL
  182. -->   Opt Data for the directory handling so  that you can customize the
  183. -->   TYPE=46 as needed.
  184.  
  185.       Now bring up TBBS and run the new menu option.
  186.  
  187.  
  188.   Running:
  189.  
  190.      After the TPG is installed as a menu option the user will then call
  191.      the function just like a TYPE=4 but it will act like a group of
  192.      linked type 46's.  The first thing the user will see is:
  193.  
  194.         Current Area = '1 - Recent User Uploads'
  195.         Hit return to use this area, A to switch areas, Q to quit ->
  196.  
  197.      The above line will always "dump" the user in the first file
  198.      area of your ".FAR" group of areas. The area number is listed
  199.      along with the correct area description from your real .FAR with
  200.      the little single quotes on either side to highlight it.
  201.      The next line gives the option to use the area, switch to another
  202.      area or quit. If the user just hits Q to quit he will exit out
  203.      of the menu selection and go back to the calling menu. If the user
  204.      hits the A to switch areas he will be presented with ALL the areas
  205.      available. 18 areas are displayed along with the option to choose
  206.      one, quit the option or continue listing them. If the user wants
  207.      to select an area HIGHER than one listed they can do so, but not
  208.      one higher than the highest you have or they will get a warning message.
  209.      If the user does not quit out or pick a specific area, hitting return
  210.      displays another 18 areas and continues to do this until ALL areas
  211.      of your .FAR database have displayed. If you have less than 18 areas
  212.      they will display normally. If the user simply hit return from the
  213.      "Current Area...." prompt above they are dumped to the actual TYPE=46
  214.      menu option. If they chose to select another area they will see
  215.      the above prompt again but with the new area number and the new
  216.      area description. When they are done switching areas or just hit
  217.      return at the above prompt, the TYPE 46 prompt comes up like this:
  218.  
  219.        <P>rotocol, <E>xamine, <N>ew, <L>ist, <H>elp
  220.        Selection or <CR> to exit:
  221.  
  222.      Of course the above is the standard TYPE=46 option. With this current
  223.      setup the files will not automatically list, in the registered version
  224.      you do not have to do it that way, you can create any OPT DATA choices
  225.      for your preference. My experiance is that NOT displaying the files
  226.      automatically is prefered by users as many have MNP or V.42 modems
  227.      and don't want to get the listings started if they just want to
  228.      perform a command or type in a file. With the error correcting modems
  229.      they will get the elasticity while the files start to display and
  230.      they may not understand why the files are listing, they try to hit
  231.      the S or P to stop or pause but continue to get a stream of data
  232.      due to the buffering. I always recommend you dump the user at the prompt
  233.      and let them do the files listing if they want. The above command
  234.      line "<P>rotocol, <E>xamine......" may not look the same if you
  235.      used EDLANG to change it.  The "Current Area" prompt above it will
  236.      always look the same, only the area changes as they select it.
  237.  
  238.      NOW, at the above prompt the user can enter any normal command that
  239.      they would be allowed to in this type of TYPE=46 menu option. If they
  240.      do a <N>ew command or a <L>ist then ONLY that area they are in will
  241.      be processed. The other areas of this ".FAR" will not be processed
  242.      because we are simulating the ".FAR" with this FARPLUS program.
  243.      If they just hit return they will go back to the "Current Area.."
  244.      prompt. At that point again they can use the area, change areas
  245.      or quit to the calling menu. If they repeatedly hit return they
  246.      toggle back and forth from the "Current Area..." prompt and the
  247.      "<P>rotocol, <E>xamine...." prompt.  This is especially useful for
  248.      new users who almost always seem to hit return spasmodically and
  249.      get kicked out to the calling menu. The only way to the menu is to
  250.      select the quit option from the "Current Area...." prompt.
  251.  
  252.      This is really a simple process that your users will pick up and they
  253.      will soon realize that they no longer can do a <N>ew to check
  254.      all areas at once OR use the <L>ist with a string to list ALL occurances
  255.      of a string in all areas. If you have a big file area you probably
  256.      created a <Z>ippy search which will do this much faster and will
  257.      not beat the crap out of your hard drives.  On the other hand if
  258.      you want users to be able to do a <L>ist or <N>ew or some other
  259.      legal command to affect all areas of a .FAR then you probably don't
  260.      want to use this program.
  261.  
  262. Sysops console display:
  263.  
  264.      When a user executes this function, the sysop console will at
  265.      first show the UD200, which denotes that the user is running a
  266.      TDBS "door", but when a user ACTUALLY picks an area the sysop
  267.      console will show them doing a "Pdnld" which is a TBBS function.
  268.      I don't quite understand how TDBS calls TBBS internal functions
  269.      but this process of using a TDBS application to simulate an
  270.      enhanced TYPE=4 is just as fast as the TYPE=4 itself.
  271.  
  272. Final Notes:
  273.  
  274.      This version does not allow you to customize the TYPE=46 optional
  275.      data. The registered version allows ANY legal switches the
  276.      TYPE=46 can handle. You will be able to enter the switches for
  277.      the TYPE=46 handling of this simulated .FAR by adding them to
  278.      the menu option that calls the FARPLUS.TPG program.
  279.  
  280. Registration:
  281.  
  282.      All I do for a living is run my bbs and write TBBS/TDBS applications.
  283.      If you have a full time job and like the stuff I write, please
  284.      consider registering the programs you use.  I think the fees I request
  285.      for my programs are very reasonable and most of the programs are
  286.      usually very useful enhancements or extensions of the TBBS environment
  287.      which require alot of thought and watching over a bbs to devise the
  288.      best possible implementation for each program. If I continue to get
  289.      the support of the TBBS sysops, as I have in the past, I will continue
  290.      to write all these oddball programs for reasonable prices.
  291.  
  292. The End?-
  293.  
  294.       Since its obvious I don't write documentation for a living and
  295.       don't intend to spend lengthy time writing an extensive manual for
  296.       what is quite a simple program, it is possible I left out a few
  297.       items that may be important to you. If you find bugs or problems
  298.       in using this program or if you have any comments or criticisms,
  299.       you can contact me via mail on the following systems:
  300.  
  301.        SYSTEM NAME      - PHONE NUMBER -  LEAVE MAIL TO:
  302.        ---------------------------------------------------
  303.        PDSLO BBS        - 516-938-6722 - JIM TORO or SysOp
  304.                         - 516-938-0675 - (FAX machine)
  305.  
  306.        TBBS SUPPORT BBS - 303-699-8222 - JAMES TORO
  307.  
  308.